home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #14 / Monster Media No. 14 (April 1996) (Monster Media, Inc.).ISO / rem_acc / glsbull1.zip / GLSBULL.DOC < prev    next >
Text File  |  1996-03-02  |  20KB  |  464 lines
  1.                         Doc Release 25th February 1996
  2.  
  3.  
  4.  
  5.  
  6.           GreenLights Software Bulletin Generator
  7.  
  8.                     For
  9.  
  10.             RemoteAccess 2.00, 2.01, 2.02, 2.50
  11.  
  12.                   GLSBULL.EXE v1.01
  13.  
  14.  
  15.   Copyright(c) 1996, Jeffrey R Dougall - GreenLights Software Development
  16.                   FidoNET 3:640/280
  17.                BBS +61 7 3201 6576 (9600-28800)
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.                     1
  25.  
  26.       1.1   License and disclaimer
  27.  
  28.       "GLSBULL"  refers to  the  executable  and  documentation  in  the
  29.       original distribution archive.  GLSBULL is copyrighted  material by
  30.       Jeffrey R. Dougall. It  may only be used  in agreement with  the
  31.       conditions set out in this license agreement.
  32.  
  33.       GLSBULL may  be freely distributed as long  as no files are removed
  34.       from the package and the files  are not modified in any way,  and
  35.       as  long  as no  money  or  any other  compensation  is asked  or
  36.       accepted for this  package without prior written  permission from
  37.       the author.
  38.  
  39.       Although  care has been  taken to write  and test a  program that
  40.       does what  this document states,  the program is provided  as is,
  41.       without warranty  or guarantee of  any kind, either  expressed or
  42.       implied, as to the quality or performance of this program, except
  43.       that it will occupy disk space.
  44.  
  45.       The author, Jeffrey R.  Dougall, will not be held  liable to you
  46.       or  anyone  for  (but  not  limited  to)  any  direct,  indirect,
  47.       incidental or consequential damages,  including any lost profits,
  48.  
  49.                       2
  50.  
  51.  
  52.  
  53.  
  54.  
  55.       lost savings  which may result from  the use or  inability to use
  56.       this program.
  57.  
  58.       Jeffrey R. Dougall   is in  no way  obligated to  provide future
  59.       versions of, or support for this software.
  60.  
  61.       Your  use  of  the  program constitutes  your  agreement  to this
  62.       license and  disclaimer and your  release of the author  from any
  63.       form of liability or litigation.
  64.  
  65.  
  66.  
  67.       1.2   Registration
  68.  
  69.       This release of GLSBULL may be used free of charge for  individual
  70.       hobby use in REGISTERED mode for a total period of 40 days after
  71.       which GLSBULL will de-activate REGISTERED mode and some features
  72.       will become in operate. GLSBULL may operate unpredictably if the
  73.       file(s) used to calculate the length of operation in FREE registered
  74.       mode are tampered with ...
  75.  
  76.       To register your copy of GLSBULL read the doc file GLSBULL.REG
  77.  
  78.  
  79.                      3
  80.  
  81.  
  82.           FILES used and created by GLSBULL.EXE
  83.           +++++++++++++++++++++++++++++++++++++
  84.  
  85.       GLSBULL.EXE The main executable file
  86.       GLSBULL.DAT Display information
  87.       GLSBULL.CFG Configuration file created by GLSBULL.EXE
  88.       GLSBULL.REC Created after running GLSBULL.EXE for the first time.
  89.           Used by GLSBULL so that dupe messages are not sent.
  90.       GLSPOST.EXE Used by GLSBULL to send messages.
  91.       GLSPOST.DAT Data file used by GLSPOST.EXE
  92.  
  93.     GLS??????.MSG files are explained below.
  94.     GLS??????.ASC bulletin you display to callers
  95.  
  96.       GLSBULL creates a file GLSBULL.REC when first run. this file
  97.       contains the names of the people a message was last sent to.
  98.       This is used by GLSBULL to ensure the same message is not sent
  99.       twice to a caller. The format is as follows
  100.  
  101.       GLSBULL.REC
  102.       -----------
  103.       Joan Doe    LINE 1 Top Uploader
  104.       Tom Doe     LINE 2 Top Caller
  105.       John Doe    LINE 3 Top Message writer
  106.           END
  107.  
  108.  
  109.       The program uses the following TEXT files as the base template for
  110.       posting messages to your callers ...
  111.  
  112.                   4
  113.  
  114.       GLSTHKF.MSG When a caller is NUMBER 1 in the top ten uploaders
  115.            GLSBULL will post this message to him/her
  116.            The message is sent once only.
  117.       GLSTHKM.MSG When a caller is NUMBER 1 in the top ten Message writters
  118.            GLSBULL will post this message to him/her
  119.            The message is sent once only.
  120.       GLSTHKC.MSG When a caller is NUMBER 1 in the top ten CALLERS
  121.            the GLSBULL will post this message to him/her
  122.            The message is sent once only.
  123.  
  124.        GLSOOPSF.MSG When a caller looses number 1 position this message
  125.            will be sent. (Top uploader)
  126.        GLSOOPSC.MSG When a caller looses number 1 position this message
  127.            will be sent. (Best caller)
  128.        GLSOOPSM.MSG When a caller looses number 1 position this message
  129.            will be sent. (Best message writer)
  130.  
  131.  
  132.       GLSBIRTH.MSG This message is sent to a caller on his/her birthday
  133.     GLSSUB.MSG Created when a person subscription is due
  134.     GLS1ST.MSG Sent to NEW callers
  135.  
  136.                    5
  137.  
  138.              WHAT DOES GLSBULL.EXE DO?
  139.              -------------------------
  140.   1 Writes bulletins for the top 14 callers, uploaders, message writers
  141.     and downloaders.
  142.  
  143.   2 Sends a welcome message to new callers
  144.  
  145.   3 Sends a birthday wish to your callers on their birthday
  146.  
  147.   4 Sends a subscription reminder notice to your VIPS's 21 days prior
  148.     to subscription expires.
  149.  
  150.   5 When a caller makes number one position on the Best callers/Uploaders
  151.     and message writers bulletins GLSBULL will send them a congratulations
  152.     message to encourage further uploading etc.
  153.  
  154.   6 When a person who held number one position looses it a Boo! Hisss
  155.     message is sent to him/her to encourage, again, more uploads/message
  156.     writing etc. Not really needed, just thrown in for fun.
  157.  
  158.   7 GLSBULL is year 2000 aware but is limited until RemoteAccess fully
  159.     supports 4 digit year entry and as soon as RA does the transition
  160.     an immediate update release of GLSBULL will be made available.
  161.  
  162.     For those not aware, any program which does not support 4 digit
  163.     year entry will fail to function correctly after the turn of the
  164.     century! meaning a person born in the year 1964 for example will
  165.     suddenly be 64 years old in the year 2000.
  166.  
  167.                     6
  168.  
  169.                 INSTALLATION
  170.                 ------------
  171.  
  172.   The GLSBULL archive comes with 5 files and after running the first time
  173.   several more files are created so it is strongly advised  give GLSBULL
  174.   a directory of its own.
  175.  
  176.   Once creating the directory and unpacking the files start GLSBULL.EXE
  177.   so that the required configuration file and other relevant files can be
  178.   created.
  179.  
  180.   GLSBULL will look for your RemoteAccess configuration files to obtain
  181.   information about you and your BBS so that you do not have to go through
  182.   a lengthy setup operation.
  183.  
  184.   Once obtaining your details GLSBULL will ask you if you want messages to
  185.   be sent to your callers. If you answer NO, GLSBULL will ask no more
  186.   questions and return to dos after writing your CFG file to HDD.
  187.  
  188.   If you answer YES, GLSBULL will ask you for a HUDSON message board number
  189.   which is required if you wish to have GLSBULL send messages to your callers.
  190.  
  191.   You are then given the option to have GLSBULL post your VIP's a reminder
  192.   to renew their subscription to your BBS 21 days before the due date.
  193.   GLSBULL will ask you to enter a security number between 0-65535.
  194.   Enter 65535 if you don't wish reminders sent by GLSBULL.
  195.  
  196.   If you have a registered copy of GLSBULL and enter a security number of
  197.   1000, GLSBULL will treat all users with a security of 1000 and above as
  198.   VIPS and send them a subscription reminder. In other words, GLBULL will
  199.   send a reminder to all those equal to or greater than the security number
  200.   you enter.
  201.  
  202.   Unregistered users will be restricted in that GLSBULL will only send a
  203.   reminder to those users EQUAL to the security number you enter.
  204.  
  205.   GLSBULL will now create several files with the file extension MSG which
  206.   are the templates used when posting messages to your callers. GLSBULL
  207.   will place your name and the name of your BBS in these messages. You
  208.   may edit these templates with a TXT editor if you wish.
  209.                     7
  210.                CONFIGURING RemoteAccess
  211.                ------------------------
  212.  
  213. GLSBULL generates 6 bulletin files these are:-
  214.  
  215.            GLSCALL.ASC  Top 14 callers
  216.            GLSMESS.ASC   "  "  message writers
  217.         GLSKUP.ASC   "  "  uploaders by K/bytes
  218.           GLSKDOWN.ASC   "  "  downloaders by K/bytes
  219.          GLSUP.ASC   "  "  uploders by files
  220.            GLSDOWN.ASC   "  "  downloaders by files
  221.  
  222. GLSBULL makes good use of RA's inbuilt colour codes so GLSBULL does not
  223. produce ANSI screens. Instead, ASC txt files are created and the colour
  224. codes are embedded into the bulletins. This way RA will send the ASC
  225. bulletins to all callers wether they be, ANSI, AVITAR, ASC or RIP in
  226. full colour or B/W if the caller is using a TTY terminal.
  227.  
  228. This not only saves on HDD space but also speeds the process of producing
  229. the bulletins PLUS you only have 6 bulletins in your text file directory
  230. instead of 12! In other words GLSBULL does not waste time/space duplicating
  231. the bulletins !
  232.  
  233. When you start GLSBULL she will look for your CONFIG.RA file which contains
  234. information about you and the location of your MSGBASE files and TXTFILES
  235. directory.
  236.                     8
  237. In the sample RACONFIG below you will see Textfiles  \ra\txtfiles so
  238. what-ever you have entered there, will be the location GLSBULL will create
  239. your bulletins. IMPORTANT if your running GLSBULL from a different DRIVE
  240. to you TXTFILES directory you MUST include the drive Letter in RACONFIG!
  241.  
  242.  
  243.      File   System  Options Modem   Manager
  244. ════════════════════╒═══════════╕═══════════════════════════════════════════════
  245. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  246. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ Site info │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  247. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ Addresses │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  248. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ Security  │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  249. ▒▒╒═══════════════════════════════════════════════════════════════════ Paths ╕▒▒
  250. ▒▒│                                                                       │▒▒
  251. ▒▒│ System      \RA\                                                     │▒▒
  252. ▒▒│ Menus       \RA\MENUS\                                                 │▒▒
  253. ▒▒│ Textfiles   \RA\TXTFILES\   <<<<<< GLSBULL uses this directory to store  │▒▒
  254. ▒▒│ Msg base    \RA\MSGBASE\       your bulletins                       │▒▒
  255. ▒▒│ File base   \RA\FILES\                                                 │▒▒
  256. ▒▒│ File attach \RA\ATTACH\                                               │▒▒
  257. ▒▒│ Nodelist    \FD\NODELIST\                                           │▒▒
  258. ▒▒│ CD-ROM temp \RA\CDROM\                                                 │▒▒
  259. ▒▒│ Semaphore   \RA\SEM\                                                     │▒▒
  260. ▒▒│ Rearchive                                                           │▒▒
  261. ▒▒│ System log  \RA\RA.LOG                                                 │▒▒
  262. ▒▒│                                                                       │▒▒
  263. ▒▒╘══════════════════════════════════════════════════════════════════════════╛▒▒
  264. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  265. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  266. ────────────────────────────────────────────────────────────────────────────────
  267.  
  268.                     9
  269. After the bulletins are created you have to setup a menu in your BBS to
  270. display the bulletins to your callers. You may create a special menu for this
  271. purpose or use any of your current menu's.
  272.  
  273. Below you will see a sample menu which allows your callers to show the
  274. bulletins when they press the corresponding hot key. If they press A
  275. RA will display the bulletin "GLSCALL.ASC" etc etc.
  276.  
  277. ╒══════════════════════════════════════════════════════ C:\RA\MENUS\BULL.MNU   ╕
  278. │                         │***│ Display-H  │ bulletin                    │
  279. │                         │'A'│ Disp CR    │ GLSCALL                      │
  280. │                         │'B'│ Disp CR    │ GLSDOWN                      │
  281. │                         │'C'│ Disp CR    │ GLSUP                          │
  282. │                         │'D'│ Disp CR    │ GLSMESS                      │
  283. │                         │'E'│ Disp CR    │ GLSKDOWN                    │
  284. │                         │'F'│ Disp CR    │ GLSKUP                        │
  285. │                         │'M'│ Return     │                              │
  286. │                                                                             │
  287. │                                                                             │
  288. ╘══════════════════════════════════════════════════════════════════════════════╛
  289. Enter-Edit   Ins-Insert  Del-Delete  Esc-Exit
  290. ALT: L-Load  S-Save      P-Prompt    D-Display    N-Language
  291.  
  292.   Bellow is a more detailed layout on how to set RA up to display your
  293.   bulletins. Make sure you use a TYPE 45 menu command so that RA will
  294.   prompt the caller to press enter to continue at the end of the
  295.   bulletin.
  296. ╒══════════════════════════════════════════════════════════════ Edit Menu Item ╕
  297. │                                                                             │
  298. │         1      2       3       4       5       6       7       │
  299. │ 123456789012345678901234567890123456789012345678901234567890123456789012345  │
  300. │ ;                                                                         │
  301. │                                                                             │
  302. │ GLSCALL                                                                     │
  303. │                                                                             │
  304. │ Action   Display .ANS/.ASC with CR pause at end (Type 45)                 │
  305. │ Display                                                                     │
  306. │ OptData                                                                     │
  307. │ HotKey   A                                                               │
  308. │ AutoExec No                                                             │
  309. │ Colour   Colour example                                                     │
  310. │                                                                             │
  311. │ MinSec   0              TimeUsed 0              FlatCost 0       │
  312. │ MaxSec   0              TimeLeft 0              TimeCost 0       │
  313. │ A flags  --------        Age      0             Terminal Any   │
  314. │ B flags  --------        MinSpeed 0             Nodes         │
  315. │ C flags  --------        MaxSpeed 0             Groups               │
  316. │ D flags  --------        Credit   0             DayTimes           │
  317. │                                                                             │
  318. │                                                                             │
  319. ╘══════════════════════════════════════════════════════════════════════════════╛
  320. What will happen when item is selected
  321.  
  322.                     10
  323.  
  324.                 DAILY MAINTENANCE
  325.                 -----------------
  326.  
  327.   GLSBULL should be included in your daily maintenance so that bulletins
  328.   can be updated daily. DO NOT RUN GLSBULL more than once a day if you have
  329.   the message posting active otherwise GLSBULL may post duplicate
  330.   messages to your callers. You have been warned!
  331.  
  332.   From this point on it is assumed you have read the docs that came with
  333.   your copy of RemoteAccess and you understand the terms used.
  334.  
  335.   A typical batch file that runs GLSBULL might look something like this
  336.  
  337.   When useing RA without a mailer you will have to setup an EVENT ERRORLEVEL
  338.   EXIT in RACONFIG. In this sample we will have RA exit with an errorlevel
  339.   of 100 to activate GLSBULL daily.
  340.  
  341. :STARTBBS
  342. CD\RA\NODE1
  343. RA -N1 -B%1%5 -D
  344. IF ERRORLEVEL 100 GOTO DAILYMAINT:
  345. GOTO STARTBBS
  346. :DAILYMAINT
  347. CD\RA\DOOR\GLSBULL
  348. GLSBULL.EXE
  349. GOTO STARTBBS:
  350.                     11
  351.   When using RA with a front end mailer such as Frontdoor you will have
  352.   to set your mailer up to do a forced event X exit which will ensure
  353.   that GLSBULL is run daily which must be done if you have activated
  354.   the message posting feature.
  355.  
  356.   A typical batch file used in conjunction with RA and Frontdoor might
  357.   look something like this.
  358.  
  359. @ECHO OFF
  360. :START
  361. CD\FD
  362. FD
  363. IF ERRORLEVEL 220 GOTO MAILRECIEVED
  364. IF ERRORLEVEL 210 GOTO DAILYMAINT
  365. IF ERRORLEVEL 100 GOTO BBS
  366. GOTO START
  367.  
  368. :BBS
  369. DOBBS.BAT
  370. GOTO START
  371.  
  372. :MAILRECIEVED
  373. CD\MAIL
  374. FMAIL3 TOSS
  375. FMAIL3 IMPORT
  376. GOTO START
  377.  
  378. ===========================================================================
  379. REM -------- DAILY Maintenance
  380. :DAILYMAINT
  381. CD \RA\DOOR\GLSBULL
  382. GLSBULL.EXE         (((GLSBULL requires no COMMAND LINES)))
  383. ===========================================================================
  384.  
  385. CD \MAIL
  386. FMAIL3 PACK
  387. FTOOLS3 MAINT /D /N /P
  388. GOTO START
  389.  
  390.                    12
  391.  
  392.               EXCLUDING USERS FROM BULLETINS
  393.               ------------------------------
  394.  
  395.   GLSBULL allows you to exclude up-to 10 users from the bulletins. This
  396.   is done by editing the control file called GLSBULL.SKP"
  397.  
  398.   It is not necessary to place your name in the list as GLSBULL excludes
  399.   the sysop by default.
  400.  
  401.   The names of the users MUST appear exactly how they do in RA's users base.
  402.   in other words the names are CASE-SENSATIVE!!!!!
  403.  
  404.  
  405.                   PROBLEMS
  406.                   --------
  407.  
  408.   Q. GLSBULL cannot find CONFIG.RA?
  409.   A. Make sure RA is setup in your dos environment before running GLSBULL.
  410.  
  411.   Q. GLBSULL still can't find CONFIG.RA?
  412.   A. Make sure CONFIG.RA is in your RA's System directory. Some silly billy's
  413.      have been known to place CONFIG.RA in the directory that they start
  414.      other nodes from. ie \ra\node1 etc.
  415.  
  416.   Q. GLSBULL Still can't locate CONFIG.RA. 
  417.   A. You are probably running GLSBULL from a differnt HDD to RA and have
  418.      RA environment varable setup so as NOT to include the drive. ie
  419.      if your have in your AUTOEXEC.BAT file RA=\RA than thats fine but
  420.      eventually you'll have problems. Make a habbit of including a drive
  421.      letter. so you would have something like this in you AUTOEXEC.BAT file
  422.      SET RA=C:\RA etc
  423.  
  424.    Q. GLSBULL is screwing up bad?
  425.    A. GLSBULL must be executed from the directory that contains all of the
  426.       GLSBULL data and cfg files otherwise she cannot locate here files.
  427.       or you have recieved a hacked copy and if so contacte the author
  428.       stating were you got your copy from.
  429.  
  430.    Q. GLSBULL posted messages for a while than stoped all together.
  431.    A. It's time you registered ... Don't you think!
  432.  
  433.    Q. GLSBULL will not let me define new user post a message delay or
  434.       allow me to define the subscription reminder period.
  435.    A. My Beta testers have be naughty! You must have a Beta version which 
  436.       should not have left the hands of the Beta testers.
  437.  
  438.    Q. GLSBULL has bugs.
  439.    A. What program doesn't?, Next question! seriously, if you find what
  440.       looks to be a bug contact the author.
  441.  
  442.    Q. I registered GLSBULL and my key does not work correctly!
  443.    A. Contact the author immediatly as your version is either a hack
  444.       or your details were recorded incorrectly in your key.
  445.  
  446.    Q. My whole message base has screwed up.
  447.    A. Tampering with DATA files can cause undesirable results. Especially
  448.       when it comes to GLSPOST. If you have been good and left the data
  449.       files alone than obtain a new copy as it would appear you have a
  450.       hacked or incomplete version of GLSBULL.
  451.  
  452.    Q. GLSPOST is configured to post messages, and post's the messages but
  453.       they cannot be found on the BBS.
  454.    A. Check your GLSBULL.CFG file and make sure you defined a HUDSON
  455.       message board that exists in your MESSAGES.RA file. If in doubt,
  456.       delete GLSBULL.CFG and re-install. If still not working, call 
  457.       the ghost busters.
  458.  
  459.    Q. What happens when my evaluation period expires?
  460.    A. GLSBULL will dissable the message posting features and run
  461.       in regular shareware mode, but will not tell your users you
  462.       havn.t enough funds to register.
  463.  
  464.